pp108 : GetCollection (CoBOC) (Deprecated)

GetCollection (CoBOC) (Deprecated)


This method is used to retrieve multiple objects. GetCollection is part of the CoBOC Methodset 4.2 in the Cordys CoBOC application package.

SOAP Request

<GetCollection xmlns="http://schemas.cordys.com/4.2/coboc">
    <folder filter="folder" type="entity" version="user">/test_folder</folder>
</GetCollection>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

filter

Contains the filter to be set for retrieving different types of content

String

The following table lists the different input values for the filter attribute.

  • To retreive an object, set filter attribute to the path of the template. You can also specify multiple filters by separating each filter with a semicolon.Example: /Sales Process/Customer; /Purchase Process/Customer
  • To retreive a folder, set filter attribute to folder.
  • To retreive a template-less object, set filter attribute to /SUPERTEMPLATE.

type

Contains the type to be set for retrieving different types of content

String

The following table lists the different input values for the type attribute.

  • To retreive an object, set type attribute to the instance.
  • To retreive a folder, set type attribute to entity.
  • To retreive a template-less object, set type attribute to instance.

version

Contains the version of the type of content

String

The supported versions are:

  • user
  • organization
  • isv
    If you do not provide the version, the system first searches in the user space, followed by the organization space, and then in the isv space.

SOAP Response

<GetCollectionResponse xmlns="http://schemas.cordys.com/4.2/coboc"> <tuple lastModified="1172739238209" key="/test_folder/test_template" name="test_template" entity_id="117190640673214" level="user"> </GetCollectionResponse>

Response Parameters

Field

Description

lastModified

Last date and time of modification of the object. This information can be used while updating the object

key

Name of the object along with the full path

name

Name of the object

level

Version of the object

entity_id

ID of the object

customkey

Custom key value of the object

cursor

Indicates the number of rows a query returns